/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.web.servlet;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebListener;
import javax.servlet.annotation.WebServlet;

import org.springframework.context.annotation.Import;
import org.springframework.core.annotation.AliasFor;

/**
 * 启用对 Servlet 组件（{@link WebFilter} 过滤器、{@link WebServlet} servlet 和 {@link WebListener} 监听器）的扫描。
 * 仅在使用内嵌式 Web 服务器时才会执行扫描。
 * <p>
 * 通常应指定 {@code value}、{@code basePackages} 或 {@code basePackageClasses} 之一，
 * 以控制要扫描组件的包。如果都未指定，则会从标注了该注解的类所在的包开始扫描。
 *
 * @author Andy Wilkinson
 * @since 1.3.0
 * @see WebServlet
 * @see WebFilter
 * @see WebListener
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(ServletComponentScanRegistrar.class)
public @interface ServletComponentScan {

	/**
	 * {@link #basePackages()} 属性的别名。用于更简洁地声明注解，例如：
	 * {@code @ServletComponentScan("org.my.pkg")} 等同于
	 * {@code @ServletComponentScan(basePackages="org.my.pkg")}。
	 * @return 要扫描的基础包
	 */
	@AliasFor("basePackages")
	String[] value() default {};

	/**
	 * 要扫描带注解 Servlet 组件的基础包。{@link #value()} 是该属性的别名（并且二者互斥）。
	 * <p>
	 * 推荐使用 {@link #basePackageClasses()} 以类型安全方式指定包名，避免基于字符串的错误。
	 * @return 要扫描的基础包
	 */
	@AliasFor("value")
	String[] basePackages() default {};

	/**
	 * {@link #basePackages()} 的类型安全替代方式，用于指定要扫描带注解 Servlet 组件的包。
	 * 将扫描每个指定类所在的包。
	 * @return 所在包将被扫描的类
	 */
	Class<?>[] basePackageClasses() default {};

}
